home *** CD-ROM | disk | FTP | other *** search
/ PC Advisor 2011 May / PC Advisor 190 E.iso / pc / ESSENTIALS / VLC Media Player 1.1 / vlc-1.1.5-win32.exe / sdk / include / vlc / plugins / vlc_input.h < prev    next >
Encoding:
C/C++ Source or Header  |  2010-11-13  |  21.6 KB  |  677 lines
  1. /*****************************************************************************
  2.  * vlc_input.h: Core input structures
  3.  *****************************************************************************
  4.  * Copyright (C) 1999-2006 the VideoLAN team
  5.  * $Id: 4b161b8ca903d938106c531abb8a0ecfaab6c89e $
  6.  *
  7.  * Authors: Christophe Massiot <massiot@via.ecp.fr>
  8.  *          Laurent Aimar <fenrir@via.ecp.fr>
  9.  *
  10.  * This program is free software; you can redistribute it and/or modify
  11.  * it under the terms of the GNU General Public License as published by
  12.  * the Free Software Foundation; either version 2 of the License, or
  13.  * (at your option) any later version.
  14.  *
  15.  * This program is distributed in the hope that it will be useful,
  16.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18.  * GNU General Public License for more details.
  19.  *
  20.  * You should have received a copy of the GNU General Public License
  21.  * along with this program; if not, write to the Free Software
  22.  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23.  *****************************************************************************/
  24.  
  25. /* __ is need because conflict with <vlc/input.h> */
  26. #ifndef VLC_INPUT_H
  27. #define VLC_INPUT_H 1
  28.  
  29. /**
  30.  * \file
  31.  * This file defines functions, structures and enums for input objects in vlc
  32.  */
  33.  
  34. #include <vlc_es.h>
  35. #include <vlc_meta.h>
  36. #include <vlc_epg.h>
  37. #include <vlc_events.h>
  38. #include <vlc_input_item.h>
  39.  
  40. #include <string.h>
  41.  
  42. /*****************************************************************************
  43.  * Meta data helpers
  44.  *****************************************************************************/
  45. static inline void vlc_audio_replay_gain_MergeFromMeta( audio_replay_gain_t *p_dst,
  46.                                                         const vlc_meta_t *p_meta )
  47. {
  48.     const char * psz_value;
  49.  
  50.     if( !p_meta )
  51.         return;
  52.  
  53.     if( (psz_value = vlc_meta_GetExtra(p_meta, "REPLAYGAIN_TRACK_GAIN")) ||
  54.         (psz_value = vlc_meta_GetExtra(p_meta, "RG_RADIO")) )
  55.     {
  56.         p_dst->pb_gain[AUDIO_REPLAY_GAIN_TRACK] = true;
  57.         p_dst->pf_gain[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
  58.     }
  59.     else if( (psz_value = vlc_meta_GetExtra(p_meta, "REPLAYGAIN_TRACK_PEAK" )) ||
  60.              (psz_value = vlc_meta_GetExtra(p_meta, "RG_PEAK" )) )
  61.     {
  62.         p_dst->pb_peak[AUDIO_REPLAY_GAIN_TRACK] = true;
  63.         p_dst->pf_peak[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
  64.     }
  65.     else if( (psz_value = vlc_meta_GetExtra(p_meta, "REPLAYGAIN_ALBUM_GAIN" )) ||
  66.              (psz_value = vlc_meta_GetExtra(p_meta, "RG_AUDIOPHILE" )) )
  67.     {
  68.         p_dst->pb_gain[AUDIO_REPLAY_GAIN_ALBUM] = true;
  69.         p_dst->pf_gain[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
  70.     }
  71.     else if( (psz_value = vlc_meta_GetExtra(p_meta, "REPLAYGAIN_ALBUM_PEAK" )) )
  72.     {
  73.         p_dst->pb_peak[AUDIO_REPLAY_GAIN_ALBUM] = true;
  74.         p_dst->pf_peak[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
  75.     }
  76. }
  77.  
  78. /*****************************************************************************
  79.  * Seek point: (generalisation of chapters)
  80.  *****************************************************************************/
  81. struct seekpoint_t
  82. {
  83.     int64_t i_byte_offset;
  84.     int64_t i_time_offset;
  85.     char    *psz_name;
  86.     int     i_level;
  87. };
  88.  
  89. static inline seekpoint_t *vlc_seekpoint_New( void )
  90. {
  91.     seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
  92.     point->i_byte_offset =
  93.     point->i_time_offset = -1;
  94.     point->i_level = 0;
  95.     point->psz_name = NULL;
  96.     return point;
  97. }
  98.  
  99. static inline void vlc_seekpoint_Delete( seekpoint_t *point )
  100. {
  101.     if( !point ) return;
  102.     free( point->psz_name );
  103.     free( point );
  104. }
  105.  
  106. static inline seekpoint_t *vlc_seekpoint_Duplicate( const seekpoint_t *src )
  107. {
  108.     seekpoint_t *point = vlc_seekpoint_New();
  109.     if( src->psz_name ) point->psz_name = strdup( src->psz_name );
  110.     point->i_time_offset = src->i_time_offset;
  111.     point->i_byte_offset = src->i_byte_offset;
  112.     return point;
  113. }
  114.  
  115. /*****************************************************************************
  116.  * Title:
  117.  *****************************************************************************/
  118. typedef struct
  119. {
  120.     char        *psz_name;
  121.  
  122.     bool        b_menu;      /* Is it a menu or a normal entry */
  123.  
  124.     int64_t     i_length;   /* Length(microsecond) if known, else 0 */
  125.     int64_t     i_size;     /* Size (bytes) if known, else 0 */
  126.  
  127.     /* Title seekpoint */
  128.     int         i_seekpoint;
  129.     seekpoint_t **seekpoint;
  130.  
  131. } input_title_t;
  132.  
  133. static inline input_title_t *vlc_input_title_New(void)
  134. {
  135.     input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );
  136.  
  137.     t->psz_name = NULL;
  138.     t->b_menu = false;
  139.     t->i_length = 0;
  140.     t->i_size   = 0;
  141.     t->i_seekpoint = 0;
  142.     t->seekpoint = NULL;
  143.  
  144.     return t;
  145. }
  146.  
  147. static inline void vlc_input_title_Delete( input_title_t *t )
  148. {
  149.     int i;
  150.     if( t == NULL )
  151.         return;
  152.  
  153.     free( t->psz_name );
  154.     for( i = 0; i < t->i_seekpoint; i++ )
  155.     {
  156.         free( t->seekpoint[i]->psz_name );
  157.         free( t->seekpoint[i] );
  158.     }
  159.     free( t->seekpoint );
  160.     free( t );
  161. }
  162.  
  163. static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t )
  164. {
  165.     input_title_t *dup = vlc_input_title_New( );
  166.     int i;
  167.  
  168.     if( t->psz_name ) dup->psz_name = strdup( t->psz_name );
  169.     dup->b_menu      = t->b_menu;
  170.     dup->i_length    = t->i_length;
  171.     dup->i_size      = t->i_size;
  172.     dup->i_seekpoint = t->i_seekpoint;
  173.     if( t->i_seekpoint > 0 )
  174.     {
  175.         dup->seekpoint = (seekpoint_t**)calloc( t->i_seekpoint,
  176.                                                 sizeof(seekpoint_t*) );
  177.  
  178.         for( i = 0; i < t->i_seekpoint; i++ )
  179.         {
  180.             dup->seekpoint[i] = vlc_seekpoint_Duplicate( t->seekpoint[i] );
  181.         }
  182.     }
  183.  
  184.     return dup;
  185. }
  186.  
  187. /*****************************************************************************
  188.  * Attachments
  189.  *****************************************************************************/
  190. struct input_attachment_t
  191. {
  192.     char *psz_name;
  193.     char *psz_mime;
  194.     char *psz_description;
  195.  
  196.     int  i_data;
  197.     void *p_data;
  198. };
  199.  
  200. static inline input_attachment_t *vlc_input_attachment_New( const char *psz_name,
  201.                                                             const char *psz_mime,
  202.                                                             const char *psz_description,
  203.                                                             const void *p_data,
  204.                                                             int i_data )
  205. {
  206.     input_attachment_t *a =
  207.         (input_attachment_t*)malloc( sizeof(input_attachment_t) );
  208.     if( !a )
  209.         return NULL;
  210.     a->psz_name = strdup( psz_name ? psz_name : "" );
  211.     a->psz_mime = strdup( psz_mime ? psz_mime : "" );
  212.     a->psz_description = strdup( psz_description ? psz_description : "" );
  213.     a->i_data = i_data;
  214.     a->p_data = NULL;
  215.     if( i_data > 0 )
  216.     {
  217.         a->p_data = malloc( i_data );
  218.         if( a->p_data && p_data )
  219.             memcpy( a->p_data, p_data, i_data );
  220.     }
  221.     return a;
  222. }
  223. static inline input_attachment_t *vlc_input_attachment_Duplicate( const input_attachment_t *a )
  224. {
  225.     return vlc_input_attachment_New( a->psz_name, a->psz_mime, a->psz_description,
  226.                                      a->p_data, a->i_data );
  227. }
  228. static inline void vlc_input_attachment_Delete( input_attachment_t *a )
  229. {
  230.     if( !a )
  231.         return;
  232.     free( a->psz_name );
  233.     free( a->psz_mime );
  234.     free( a->psz_description );
  235.     free( a->p_data );
  236.     free( a );
  237. }
  238.  
  239. /*****************************************************************************
  240.  * input defines/constants.
  241.  *****************************************************************************/
  242.  
  243. /* i_update field of access_t/demux_t */
  244. #define INPUT_UPDATE_NONE       0x0000
  245. #define INPUT_UPDATE_SIZE       0x0001
  246. #define INPUT_UPDATE_TITLE      0x0010
  247. #define INPUT_UPDATE_SEEKPOINT  0x0020
  248. #define INPUT_UPDATE_META       0x0040
  249. #define INPUT_UPDATE_SIGNAL     0x0080
  250.  
  251. /**
  252.  * This defines private core storage for an input.
  253.  */
  254. typedef struct input_thread_private_t input_thread_private_t;
  255.  
  256. /**
  257.  * This defines an opaque input resource handler.
  258.  */
  259. typedef struct input_resource_t input_resource_t;
  260.  
  261. /**
  262.  * Main structure representing an input thread. This structure is mostly
  263.  * private. The only public fields are READ-ONLY. You must use the helpers
  264.  * to modify them
  265.  */
  266. struct input_thread_t
  267. {
  268.     VLC_COMMON_MEMBERS
  269.  
  270.     bool b_error;
  271.     bool b_eof;
  272.     bool b_preparsing;
  273.     bool b_dead;
  274.  
  275.     /* All other data is input_thread is PRIVATE. You can't access it
  276.      * outside of src/input */
  277.     input_thread_private_t *p;
  278. };
  279.  
  280. /**
  281.  * Record prefix string.
  282.  * TODO make it configurable.
  283.  */
  284. #define INPUT_RECORD_PREFIX "vlc-record-%Y-%m-%d-%Hh%Mm%Ss-$ N-$ p"
  285.  
  286. /*****************************************************************************
  287.  * Input events and variables
  288.  *****************************************************************************/
  289.  
  290. /**
  291.  * \defgroup inputvariable Input variables
  292.  *
  293.  * The input provides multiples variable you can write to and/or read from.
  294.  *
  295.  * TODO complete the documentation.
  296.  * The read only variables are:
  297.  *  - "length"
  298.  *  - "can-seek" (if you can seek, it doesn't say if 'bar display' has be shown
  299.  *    or not, for that check position != 0.0)
  300.  *  - "can-pause"
  301.  *  - "can-rate"
  302.  *  - "can-rewind"
  303.  *  - "can-record" (if a stream can be recorded while playing)
  304.  *  - "teletext-es" (list of id from the spu tracks (spu-es) that are teletext, the
  305.  *                   variable value being the one currently selected, -1 if no teletext)
  306.  *  - "signal-quality"
  307.  *  - "signal-strength"
  308.  *  - "program-scrambled" (if the current program is scrambled)
  309.  *  - "cache" (level of data cached [0 .. 1])
  310.  *
  311.  * The read-write variables are:
  312.  *  - state (\see input_state_e)
  313.  *  - rate, rate-slower, rate-faster
  314.  *  - position, position-offset
  315.  *  - time, time-offset
  316.  *  - title, next-title, prev-title
  317.  *  - chapter, next-chapter, next-chapter-prev
  318.  *  - program, audio-es, video-es, spu-es
  319.  *  - audio-delay, spu-delay
  320.  *  - bookmark (bookmark list)
  321.  *  - record
  322.  *  - frame-next
  323.  *  - navigation (list of "title %2i")
  324.  *  - "title %2i"
  325.  *
  326.  * The variable used for event is
  327.  *  - intf-event (\see input_event_type_e)
  328.  */
  329.  
  330. /**
  331.  * Input state
  332.  *
  333.  * This enum is used by the variable "state"
  334.  */
  335. typedef enum input_state_e
  336. {
  337.     INIT_S = 0,
  338.     OPENING_S,
  339.     PLAYING_S,
  340.     PAUSE_S,
  341.     END_S,
  342.     ERROR_S,
  343. } input_state_e;
  344.  
  345. /**
  346.  * Input rate.
  347.  *
  348.  * It is an float used by the variable "rate" in the
  349.  * range [INPUT_RATE_DEFAULT/INPUT_RATE_MAX, INPUT_RATE_DEFAULT/INPUT_RATE_MAX]
  350.  * the default value being 1. It represents the ratio of playback speed to
  351.  * nominal speed (bigger is faster).
  352.  *
  353.  * Internally, the rate is stored as a value in the range
  354.  * [INPUT_RATE_MIN, INPUT_RATE_MAX].
  355.  * internal rate = INPUT_RATE_DEFAULT / rate variable
  356.  */
  357.  
  358. /**
  359.  * Default rate value
  360.  */
  361. #define INPUT_RATE_DEFAULT  1000
  362. /**
  363.  * Minimal rate value
  364.  */
  365. #define INPUT_RATE_MIN        32            /* Up to 32/1 */
  366. /**
  367.  * Maximal rate value
  368.  */
  369. #define INPUT_RATE_MAX     32000            /* Up to 1/32 */
  370.  
  371. /**
  372.  * Input events
  373.  *
  374.  * You can catch input event by adding a callback on the variable "intf-event".
  375.  * This variable is an integer that will hold a input_event_type_e value.
  376.  */
  377. typedef enum input_event_type_e
  378. {
  379.     /* "state" has changed */
  380.     INPUT_EVENT_STATE,
  381.     /* b_dead is true */
  382.     INPUT_EVENT_DEAD,
  383.     /* a *user* abort has been requested */
  384.     INPUT_EVENT_ABORT,
  385.  
  386.     /* "rate" has changed */
  387.     INPUT_EVENT_RATE,
  388.  
  389.     /* At least one of "position" or "time" */
  390.     INPUT_EVENT_POSITION,
  391.  
  392.     /* "length" has changed */
  393.     INPUT_EVENT_LENGTH,
  394.  
  395.     /* A title has been added or removed or selected.
  396.      * It imply that chapter has changed (not chapter event is sent) */
  397.     INPUT_EVENT_TITLE,
  398.     /* A chapter has been added or removed or selected. */
  399.     INPUT_EVENT_CHAPTER,
  400.  
  401.     /* A program ("program") has been added or removed or selected,
  402.      * or "program-scrambled" has changed.*/
  403.     INPUT_EVENT_PROGRAM,
  404.     /* A ES has been added or removed or selected */
  405.     INPUT_EVENT_ES,
  406.     /* "teletext-es" has changed */
  407.     INPUT_EVENT_TELETEXT,
  408.  
  409.     /* "record" has changed */
  410.     INPUT_EVENT_RECORD,
  411.  
  412.     /* input_item_t media has changed */
  413.     INPUT_EVENT_ITEM_META,
  414.     /* input_item_t info has changed */
  415.     INPUT_EVENT_ITEM_INFO,
  416.     /* input_item_t name has changed */
  417.     INPUT_EVENT_ITEM_NAME,
  418.     /* input_item_t epg has changed */
  419.     INPUT_EVENT_ITEM_EPG,
  420.  
  421.     /* Input statistics have been updated */
  422.     INPUT_EVENT_STATISTICS,
  423.     /* At least one of "signal-quality" or "signal-strength" has changed */
  424.     INPUT_EVENT_SIGNAL,
  425.  
  426.     /* "audio-delay" has changed */
  427.     INPUT_EVENT_AUDIO_DELAY,
  428.     /* "spu-delay" has changed */
  429.     INPUT_EVENT_SUBTITLE_DELAY,
  430.  
  431.     /* "bookmark" has changed */
  432.     INPUT_EVENT_BOOKMARK,
  433.  
  434.     /* cache" has changed */
  435.     INPUT_EVENT_CACHE,
  436.  
  437.     /* A aout_instance_t object has been created/deleted by *the input* */
  438.     INPUT_EVENT_AOUT,
  439.     /* A vout_thread_t object has been created/deleted by *the input* */
  440.     INPUT_EVENT_VOUT,
  441.  
  442. } input_event_type_e;
  443.  
  444. /**
  445.  * Input queries
  446.  */
  447. enum input_query_e
  448. {
  449.     /* input variable "position" */
  450.     INPUT_GET_POSITION,         /* arg1= double *       res=    */
  451.     INPUT_SET_POSITION,         /* arg1= double         res=can fail    */
  452.  
  453.     /* input variable "length" */
  454.     INPUT_GET_LENGTH,           /* arg1= int64_t *      res=can fail    */
  455.  
  456.     /* input variable "time" */
  457.     INPUT_GET_TIME,             /* arg1= int64_t *      res=    */
  458.     INPUT_SET_TIME,             /* arg1= int64_t        res=can fail    */
  459.  
  460.     /* input variable "rate" (nominal is INPUT_RATE_DEFAULT) */
  461.     INPUT_GET_RATE,             /* arg1= int *          res=    */
  462.     INPUT_SET_RATE,             /* arg1= int            res=can fail    */
  463.  
  464.     /* input variable "state" */
  465.     INPUT_GET_STATE,            /* arg1= int *          res=    */
  466.     INPUT_SET_STATE,            /* arg1= int            res=can fail    */
  467.  
  468.     /* input variable "audio-delay" and "sub-delay" */
  469.     INPUT_GET_AUDIO_DELAY,      /* arg1 = int* res=can fail */
  470.     INPUT_SET_AUDIO_DELAY,      /* arg1 = int  res=can fail */
  471.     INPUT_GET_SPU_DELAY,        /* arg1 = int* res=can fail */
  472.     INPUT_SET_SPU_DELAY,        /* arg1 = int  res=can fail */
  473.  
  474.     /* Meta datas */
  475.     INPUT_ADD_INFO,   /* arg1= char* arg2= char* arg3=...     res=can fail */
  476.     INPUT_REPLACE_INFOS,/* arg1= info_category_t *            res=cannot fail */
  477.     INPUT_MERGE_INFOS,/* arg1= info_category_t *              res=cannot fail */
  478.     INPUT_GET_INFO,   /* arg1= char* arg2= char* arg3= char** res=can fail */
  479.     INPUT_DEL_INFO,   /* arg1= char* arg2= char*              res=can fail */
  480.     INPUT_SET_NAME,   /* arg1= char* res=can fail    */
  481.  
  482.     /* Input config options */
  483.     INPUT_ADD_OPTION,      /* arg1= char * arg2= char *  res=can fail*/
  484.  
  485.     /* Input properties */
  486.     INPUT_GET_VIDEO_FPS,         /* arg1= double *        res=can fail */
  487.  
  488.     /* bookmarks */
  489.     INPUT_GET_BOOKMARK,    /* arg1= seekpoint_t *               res=can fail */
  490.     INPUT_GET_BOOKMARKS,   /* arg1= seekpoint_t *** arg2= int * res=can fail */
  491.     INPUT_CLEAR_BOOKMARKS, /* res=can fail */
  492.     INPUT_ADD_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
  493.     INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail   */
  494.     INPUT_DEL_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
  495.     INPUT_SET_BOOKMARK,    /* arg1= int  res=can fail    */
  496.  
  497.     /* Attachments */
  498.     INPUT_GET_ATTACHMENTS, /* arg1=input_attachment_t***, arg2=int*  res=can fail */
  499.     INPUT_GET_ATTACHMENT,  /* arg1=input_attachment_t**, arg2=char*  res=can fail */
  500.  
  501.     /* On the fly input slave */
  502.     INPUT_ADD_SLAVE,       /* arg1= const char * */
  503.     INPUT_ADD_SUBTITLE,    /* arg1= const char *, arg2=bool b_check_extension */
  504.  
  505.     /* On the fly record while playing */
  506.     INPUT_SET_RECORD_STATE, /* arg1=bool    res=can fail */
  507.     INPUT_GET_RECORD_STATE, /* arg1=bool*   res=can fail */
  508.  
  509.     /* ES */
  510.     INPUT_RESTART_ES,       /* arg1=int (-AUDIO/VIDEO/SPU_ES for the whole category) */
  511.  
  512.     /* Input ressources
  513.      * XXX You must call vlc_object_release as soon as possible */
  514.     INPUT_GET_AOUT,         /* arg1=aout_instance_t **              res=can fail */
  515.     INPUT_GET_VOUTS,        /* arg1=vout_thread_t ***, size_t *        res=can fail */
  516.     INPUT_GET_ES_OBJECTS,   /* arg1=int id, vlc_object_t **dec, vout_thread_t **, aout_instance_t ** */
  517.  
  518.     /* External clock managments */
  519.     INPUT_GET_PCR_SYSTEM,   /* arg1=mtime_t *, arg2=mtime_t *       res=can fail */
  520.     INPUT_MODIFY_PCR_SYSTEM,/* arg1=int absolute, arg2=mtime_t      res=can fail */
  521. };
  522.  
  523. /** @}*/
  524.  
  525. /*****************************************************************************
  526.  * Prototypes
  527.  *****************************************************************************/
  528.  
  529. VLC_EXPORT( input_thread_t *, input_Create, ( vlc_object_t *p_parent, input_item_t *, const char *psz_log, input_resource_t * ) );
  530. #define input_Create(a,b,c,d) input_Create(VLC_OBJECT(a),b,c,d)
  531.  
  532. VLC_EXPORT( input_thread_t *, input_CreateAndStart, ( vlc_object_t *p_parent, input_item_t *, const char *psz_log ) );
  533. #define input_CreateAndStart(a,b,c) input_CreateAndStart(VLC_OBJECT(a),b,c)
  534.  
  535. VLC_EXPORT( int,  input_Start, ( input_thread_t * ) );
  536.  
  537. VLC_EXPORT( void, input_Stop, ( input_thread_t *, bool b_abort ) );
  538.  
  539. VLC_EXPORT( int, input_Read, ( vlc_object_t *, input_item_t * ) );
  540. #define input_Read(a,b) input_Read(VLC_OBJECT(a),b)
  541.  
  542. VLC_EXPORT( int, input_vaControl,( input_thread_t *, int i_query, va_list  ) );
  543.  
  544. VLC_EXPORT( int, input_Control,  ( input_thread_t *, int i_query, ...  ) );
  545.  
  546. /**
  547.  * Get the input item for an input thread
  548.  *
  549.  * You have to keep a reference to the input or to the input_item_t until
  550.  * you do not need it anymore.
  551.  */
  552. VLC_EXPORT( input_item_t*, input_GetItem, ( input_thread_t * ) );
  553.  
  554. /**
  555.  * It will return the current state of the input.
  556.  * Provided for convenience.
  557.  */
  558. static inline input_state_e input_GetState( input_thread_t * p_input )
  559. {
  560.     input_state_e state = INIT_S;
  561.     input_Control( p_input, INPUT_GET_STATE, &state );
  562.     return state;
  563. }
  564. /**
  565.  * It will add a new subtitle source to the input.
  566.  * Provided for convenience.
  567.  */
  568. static inline int input_AddSubtitle( input_thread_t *p_input, const char *psz_url, bool b_check_extension )
  569. {
  570.     return input_Control( p_input, INPUT_ADD_SUBTITLE, psz_url, b_check_extension );
  571. }
  572.  
  573. /**
  574.  * Return one of the video output (if any). If possible, you should use
  575.  * INPUT_GET_VOUTS directly and process _all_ video outputs instead.
  576.  * @param p_input an input thread from which to get a video output
  577.  * @return NULL on error, or a video output thread pointer (which needs to be
  578.  * released with vlc_object_release()).
  579.  */
  580. static inline vout_thread_t *input_GetVout( input_thread_t *p_input )
  581. {
  582.      vout_thread_t **pp_vout, *p_vout;
  583.      size_t i_vout;
  584.  
  585.      if( input_Control( p_input, INPUT_GET_VOUTS, &pp_vout, &i_vout ) )
  586.          return NULL;
  587.  
  588.      for( size_t i = 1; i < i_vout; i++ )
  589.          vlc_object_release( (vlc_object_t *)(pp_vout[i]) );
  590.  
  591.      p_vout = (i_vout >= 1) ? pp_vout[0] : NULL;
  592.      free( pp_vout );
  593.      return p_vout;
  594. }
  595.  
  596. /**
  597.  * Return the audio output (if any) associated with an input.
  598.  * @param p_input an input thread
  599.  * @return NULL on error, or the audio output (which needs to be
  600.  * released with vlc_object_release()).
  601.  */
  602. static inline aout_instance_t *input_GetAout( input_thread_t *p_input )
  603. {
  604.      aout_instance_t *p_aout;
  605.      return input_Control( p_input, INPUT_GET_AOUT, &p_aout ) ? NULL : p_aout;
  606. }
  607.  
  608. /**
  609.  * Returns the objects associated to an ES.
  610.  *
  611.  * You must release all non NULL object using vlc_object_release.
  612.  * You may set pointer of pointer to NULL to avoid retreiving it.
  613.  */
  614. static inline int input_GetEsObjects( input_thread_t *p_input, int i_id,
  615.                                       vlc_object_t **pp_decoder,
  616.                                       vout_thread_t **pp_vout, aout_instance_t **pp_aout )
  617. {
  618.     return input_Control( p_input, INPUT_GET_ES_OBJECTS, i_id,
  619.                           pp_decoder, pp_vout, pp_aout );
  620. }
  621.  
  622. /**
  623.  * \see input_clock_GetSystemOrigin
  624.  */
  625. static inline int input_GetPcrSystem( input_thread_t *p_input, mtime_t *pi_system, mtime_t *pi_delay )
  626. {
  627.     return input_Control( p_input, INPUT_GET_PCR_SYSTEM, pi_system, pi_delay );
  628. }
  629. /**
  630.  * \see input_clock_ChangeSystemOrigin
  631.  */
  632. static inline int input_ModifyPcrSystem( input_thread_t *p_input, bool b_absolute, mtime_t i_system )
  633. {
  634.     return input_Control( p_input, INPUT_MODIFY_PCR_SYSTEM, b_absolute, i_system );
  635. }
  636.  
  637. /* */
  638. typedef struct input_clock_t input_clock_t;
  639. VLC_EXPORT( decoder_t *, input_DecoderNew, ( input_thread_t *, es_format_t *, input_clock_t *, sout_instance_t * ) );
  640. VLC_EXPORT( void, input_DecoderDelete, ( decoder_t * ) );
  641. VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t *, bool b_do_pace ) );
  642.  
  643. /**
  644.  * This function allows to split a MRL into access, demux and path part.
  645.  *
  646.  *  You should not write into access and demux string as they may not point into
  647.  * the provided buffer.
  648.  *  The buffer provided by psz_dup will be modified.
  649.  */
  650. VLC_EXPORT( void, input_SplitMRL, ( const char **ppsz_access, const char **ppsz_demux, char **ppsz_path, char *psz_dup ) );
  651.  
  652. /**
  653.  * This function creates a sane filename path.
  654.  */
  655. VLC_EXPORT( char *, input_CreateFilename, ( vlc_object_t *, const char *psz_path, const char *psz_prefix, const char *psz_extension ) );
  656.  
  657. /**
  658.  * This function detaches resources from a dead input.
  659.  *
  660.  * It MUST be called on a dead input (p_input->b_dead true) otherwise
  661.  * it will assert.
  662.  * It does not support concurrent calls.
  663.  */
  664. VLC_EXPORT(input_resource_t *, input_DetachResource, ( input_thread_t * ) );
  665.  
  666. /**
  667.  * This function releases the input resource.
  668.  */
  669. VLC_EXPORT(void, input_resource_Delete, ( input_resource_t * ) );
  670.  
  671. /**
  672.  * Forcefully destroys the video output (e.g. when the playlist is stopped).
  673.  */
  674. VLC_EXPORT(void, input_resource_TerminateVout, ( input_resource_t * ) );
  675.  
  676. #endif
  677.